Skip to content

Add CI check against conventional commit messages#22421

Merged
SMillerDev merged 2 commits into
mainfrom
feat/ci/block_conventional_commits
May 27, 2026
Merged

Add CI check against conventional commit messages#22421
SMillerDev merged 2 commits into
mainfrom
feat/ci/block_conventional_commits

Conversation

@SMillerDev
Copy link
Copy Markdown
Member

Since we don't use conventional commit messages, it would be good to warn people about using them


  • Have you followed the guidelines in our Contributing document?
  • Have you checked to ensure there aren't other open Pull Requests for the same change?
  • Have you added an explanation of what your changes do and why you'd like us to include them? Performance claims (e.g. "this is faster") must include Hyperfine benchmarks.
  • Have you written new tests (excluding integration tests) for your changes? Here's an example.
  • Have you successfully run brew lgtm (style, typechecking and tests) with your changes locally?

  • AI was used to generate or assist with generating this PR.

Claude generated the whole workflow for me.


Copilot AI review requested due to automatic review settings May 26, 2026 10:39
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

This PR introduces a GitHub Actions check intended to detect and prevent (or at least flag) Conventional Commits-style prefixes (e.g., feat:, fix:) in pull request commit titles, aligning commit history with Homebrew’s preferred commit message conventions.

Changes:

  • Adds a new GitHub Actions workflow that scans PR commit subjects between the PR base and head SHAs.
  • Fails the workflow if any commit title matches a Conventional Commits-like prefix pattern.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread .github/workflows/reject-conventional-commits.yml Outdated
Comment thread .github/workflows/reject-conventional-commits.yml
Copy link
Copy Markdown
Member

@MikeMcQuaid MikeMcQuaid left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good when comments addressed!

Comment thread .github/workflows/reject-conventional-commits.yml Outdated
Comment thread .github/workflows/reject-conventional-commits.yml Outdated
Comment thread .github/workflows/reject-conventional-commits.yml
Comment thread .github/workflows/reject-conventional-commits.yml Outdated
Comment thread .github/workflows/reject-conventional-commits.yml Outdated
@SMillerDev SMillerDev force-pushed the feat/ci/block_conventional_commits branch from c5698e8 to aabf2cf Compare May 26, 2026 11:42
Since we don't use conventional commit messages, it would be good to warn people about using them
@SMillerDev SMillerDev force-pushed the feat/ci/block_conventional_commits branch from cc254dd to 93412f0 Compare May 26, 2026 11:46
@Bo98
Copy link
Copy Markdown
Member

Bo98 commented May 26, 2026

This will probably flag Dependabot though we can reintroduce the commit message config we had before: https://github.com/Homebrew/ci-orchestrator-private/blob/300aac6dd98c70b0d8f41dfcde2f99b539825a39/.github/dependabot.yml#L27-L28

Comment thread .github/workflows/reject-conventional-commits.yml Outdated
Co-authored-by: Mike McQuaid <mike@mikemcquaid.com>
@SMillerDev SMillerDev added this pull request to the merge queue May 27, 2026
Merged via the queue into main with commit 5e9b9e2 May 27, 2026
73 of 77 checks passed
@SMillerDev SMillerDev deleted the feat/ci/block_conventional_commits branch May 27, 2026 10:01
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants